<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilnvm: XilNvm Versal Net API IDs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilnvm
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xnvm__versal__net__api__ids.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">XilNvm Versal Net API IDs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa35f9d7952af5fccaed74ba5ae579191"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__versal__net__api__ids.html#gaa35f9d7952af5fccaed74ba5ae579191">XNvm_EfuseValidateAesKeyWriteReq</a> (XNvm_AesKeyType KeyType)</td></tr>
<tr class="memdesc:gaa35f9d7952af5fccaed74ba5ae579191"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function validates AES key/User Key 0/User key 1 requested for programming into eFUSEs.  <a href="#gaa35f9d7952af5fccaed74ba5ae579191">More...</a><br/></td></tr>
<tr class="separator:gaa35f9d7952af5fccaed74ba5ae579191"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacc264f1596fadaaf19db535bf527435a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__versal__net__api__ids.html#gacc264f1596fadaaf19db535bf527435a">XNvm_EfuseValidatePpkHashWriteReq</a> (XNvm_PpkType PpkType)</td></tr>
<tr class="memdesc:gacc264f1596fadaaf19db535bf527435a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function validates PPK Hash requested for programming.  <a href="#gacc264f1596fadaaf19db535bf527435a">More...</a><br/></td></tr>
<tr class="separator:gacc264f1596fadaaf19db535bf527435a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabe9934f94cf8712b7b30ad3502eb5565"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__versal__net__api__ids.html#gabe9934f94cf8712b7b30ad3502eb5565">XNvm_EfuseValidateIvWriteReq</a> (XNvm_IvType IvType, XNvm_Iv *EfuseIv)</td></tr>
<tr class="memdesc:gabe9934f94cf8712b7b30ad3502eb5565"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function validates all IVs requested for programming.  <a href="#gabe9934f94cf8712b7b30ad3502eb5565">More...</a><br/></td></tr>
<tr class="separator:gabe9934f94cf8712b7b30ad3502eb5565"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga074ef023f48a3f5164b0bf0f6d464d5c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__versal__net__api__ids.html#ga074ef023f48a3f5164b0bf0f6d464d5c">XNvm_EfuseCheckZeros</a> (u32 CacheOffset, u32 Count)</td></tr>
<tr class="memdesc:ga074ef023f48a3f5164b0bf0f6d464d5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used verify eFuse for Zeros.  <a href="#ga074ef023f48a3f5164b0bf0f6d464d5c">More...</a><br/></td></tr>
<tr class="separator:ga074ef023f48a3f5164b0bf0f6d464d5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2aca2c53d5bb8c2d003e5a5e4097b884"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__versal__net__api__ids.html#ga2aca2c53d5bb8c2d003e5a5e4097b884">XNvm_EfuseValidateDecOnlyRequest</a> (void)</td></tr>
<tr class="memdesc:ga2aca2c53d5bb8c2d003e5a5e4097b884"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function validates DEC_ONLY eFuse programming request.  <a href="#ga2aca2c53d5bb8c2d003e5a5e4097b884">More...</a><br/></td></tr>
<tr class="separator:ga2aca2c53d5bb8c2d003e5a5e4097b884"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga989884994fda65f39b2f66ced494f83d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__versal__net__api__ids.html#ga989884994fda65f39b2f66ced494f83d">XNvm_EfuseValidateFipsInfo</a> (u32 FipsMode, u32 FipsVersion)</td></tr>
<tr class="memdesc:ga989884994fda65f39b2f66ced494f83d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to validate FIPS mode and FIPS version inputs before programming.  <a href="#ga989884994fda65f39b2f66ced494f83d">More...</a><br/></td></tr>
<tr class="separator:ga989884994fda65f39b2f66ced494f83d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga05cd2825902d18394a7ba8c56c5342b6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__versal__net__api__ids.html#ga05cd2825902d18394a7ba8c56c5342b6">XNvm_IsDmeModeEn</a> (void)</td></tr>
<tr class="memdesc:ga05cd2825902d18394a7ba8c56c5342b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function checks DME Mode is enabled or disabled.  <a href="#ga05cd2825902d18394a7ba8c56c5342b6">More...</a><br/></td></tr>
<tr class="separator:ga05cd2825902d18394a7ba8c56c5342b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga51762cb7925471e499cb19ff551039d7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xnvm__versal__net__api__ids.html#ga51762cb7925471e499cb19ff551039d7">XNvm_EfuseIsPufHelperDataEmpty</a> (void)</td></tr>
<tr class="memdesc:ga51762cb7925471e499cb19ff551039d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function checks whether PUF is already programmed or not.  <a href="#ga51762cb7925471e499cb19ff551039d7">More...</a><br/></td></tr>
<tr class="separator:ga51762cb7925471e499cb19ff551039d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga074ef023f48a3f5164b0bf0f6d464d5c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_EfuseCheckZeros </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>CacheOffset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Count</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used verify eFuse for Zeros. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CacheOffset</td><td>- Cache Offset from which verification has to be started. </td></tr>
    <tr><td class="paramname">Count</td><td>- Number of rows till which verification has to be ended.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS - if eFuses are not programmed.<ul>
<li>XST_FAILURE - if eFuses are already programmed. </li>
</ul>
</dd></dl>
<p>Read ISR_REG offset. Return XNVM_EFUSE_ERR_CACHE_PARITY if not success</p>
<p>Read the eFuse data at user specified offset. Return XST_FAILURE upon failure</p>

<p>References <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fca6dbd3858b81c44129ec5b34b7e2d1733">XNVM_EFUSE_ERR_CACHE_PARITY</a>, <a class="el" href="group__xnvm__versal__net__api__ids.html#ga074ef023f48a3f5164b0bf0f6d464d5c">XNvm_EfuseCheckZeros()</a>, <a class="el" href="group__xnvm__util__apis.html#ga0b8d44122a9957c29ed1be2574a53aed">XNvm_EfuseReadReg()</a>, and <a class="el" href="group__xnvm__efuse__client__apis.html#gaea0d7fa1f00d844fe51451c22316b9e8">XNVM_WORD_LEN</a>.</p>

<p>Referenced by <a class="el" href="group__xnvm__versal__net__api__ids.html#ga074ef023f48a3f5164b0bf0f6d464d5c">XNvm_EfuseCheckZeros()</a>, <a class="el" href="group__xnvm__versal__net__api__ids.html#ga51762cb7925471e499cb19ff551039d7">XNvm_EfuseIsPufHelperDataEmpty()</a>, <a class="el" href="group__xnvm__versal__net__api__ids.html#gabe9934f94cf8712b7b30ad3502eb5565">XNvm_EfuseValidateIvWriteReq()</a>, and <a class="el" href="group__xnvm__versal__net__api__ids.html#gacc264f1596fadaaf19db535bf527435a">XNvm_EfuseValidatePpkHashWriteReq()</a>.</p>

</div>
</div>
<a class="anchor" id="ga51762cb7925471e499cb19ff551039d7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_EfuseIsPufHelperDataEmpty </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function checks whether PUF is already programmed or not. </p>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS - if all rows are zero.<ul>
<li>XNVM_EFUSE_ERR_PUF_SYN_ALREADY_PRGMD - Puf Syn data already programmed.</li>
<li>XNVM_EFUSE_ERR_PUF_CHASH_ALREADY_PRGMD - Puf chash already programmed.</li>
<li>XNVM_EFUSE_ERR_PUF_AUX_ALREADY_PRGMD - Puf Aux is already programmed. </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fca612d38e4a8fab77d9392967ab56803d0">XNVM_EFUSE_ERR_PUF_AUX_ALREADY_PRGMD</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fca79e49d3af85e9c71eb4f65d85178fd60">XNVM_EFUSE_ERR_PUF_CHASH_ALREADY_PRGMD</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fca387fc57f32a3a8ec3c211b9a719459e2">XNVM_EFUSE_ERR_PUF_SYN_ALREADY_PRGMD</a>, <a class="el" href="group__xnvm__versal__net__api__ids.html#ga074ef023f48a3f5164b0bf0f6d464d5c">XNvm_EfuseCheckZeros()</a>, <a class="el" href="group__xnvm__versal__net__api__ids.html#ga51762cb7925471e499cb19ff551039d7">XNvm_EfuseIsPufHelperDataEmpty()</a>, and <a class="el" href="group__xnvm__util__apis.html#ga0b8d44122a9957c29ed1be2574a53aed">XNvm_EfuseReadReg()</a>.</p>

<p>Referenced by <a class="el" href="group__xnvm__versal__net__api__ids.html#ga51762cb7925471e499cb19ff551039d7">XNvm_EfuseIsPufHelperDataEmpty()</a>, <a class="el" href="group__xnvm__versal__net__api__ids.html#ga2aca2c53d5bb8c2d003e5a5e4097b884">XNvm_EfuseValidateDecOnlyRequest()</a>, and <a class="el" href="group__xnvm__efuse__server__apis.html#ga3e5b32d4a7ec60464f46788458b5e67f">XNvm_EfuseWritePuf()</a>.</p>

</div>
</div>
<a class="anchor" id="gaa35f9d7952af5fccaed74ba5ae579191"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_EfuseValidateAesKeyWriteReq </td>
          <td>(</td>
          <td class="paramtype">XNvm_AesKeyType&#160;</td>
          <td class="paramname"><em>KeyType</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function validates AES key/User Key 0/User key 1 requested for programming into eFUSEs. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">KeyType</td><td>- Type of AES key requested to be validated. Possible options are AES key, User0 key and User1 key.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS - if validation is successful.<ul>
<li>XNVM_EFUSE_ERR_AES_ALREADY_PRGMD - Aes key already programmed.</li>
<li>XNVM_EFUSE_ERR_USER_KEY0_ALREADY_PRGMD - User key 0 is already programmed.</li>
<li>XNVM_EFUSE_ERR_USER_KEY1_ALREADY_PRGMD - User key 1 is already programmed.</li>
<li>XNVM_EFUSE_ERR_FUSE_PROTECTED - eFuse is write protected.</li>
<li>XNVM_EFUSE_ERR_WRITE_AES_KEY - Error in writing Aes key.</li>
<li>XNVM_EFUSE_ERR_WRITE_USER0_KEY - Error in writing User key 0.</li>
<li>XNVM_EFUSE_ERR_WRITE_USER1_KEY - Error in writing User key 1. </li>
</ul>
</dd></dl>
<p>Read the Security control eFUSE bits and check if the bit to disable AES engine is set. If set, return XNVM_EFUSE_ERR_AES_DISABLED.</p>
<p>Check if write is locked for the requested key type. If locked then return XNVM_EFUSE_ERR_FUSE_PROTECTED.</p>
<p>Check if CRC of the requested key type is zero. If non-zero then it implies that the key is already programmed and return XNVM_EFUSE_ERR_AES_ALREADY_PRGMD.</p>

<p>References <a class="el" href="group__xnvm__efuse__server__apis.html#gae90a96afb82790626728eb3e7b0f8c41">XNVM_EFUSE_CRC_AES_ZEROS</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fcaffbec4d98a496e2d70446978ad20a639">XNVM_EFUSE_ERR_AES_ALREADY_PRGMD</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fca29507bfb30c9251f84486c5cd8cb97dd">XNVM_EFUSE_ERR_AES_DISABLED</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fcad266d3a6d6afe7285781c476aa586575">XNVM_EFUSE_ERR_FUSE_PROTECTED</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fcacb1186bb45336118df73db9ea430642c">XNVM_EFUSE_ERR_WRITE_AES_KEY</a>, <a class="el" href="group__xnvm__efuse__server__apis.html#gab8f5eff3de624d650309262ed9243b29">XNVM_EFUSE_ERROR_BYTE_SHIFT</a>, <a class="el" href="group__xnvm__efuse__server__apis.html#gaba51a149137ee78fa0d298a6c79b80a1">XNVM_EFUSE_ERROR_NIBBLE_SHIFT</a>, <a class="el" href="group__xnvm__util__apis.html#ga43a467daea1ce3c434d0c01e3657c0a9">XNvm_EfuseCheckAesKeyCrc()</a>, and <a class="el" href="group__xnvm__util__apis.html#ga0b8d44122a9957c29ed1be2574a53aed">XNvm_EfuseReadReg()</a>.</p>

<p>Referenced by <a class="el" href="group__xnvm__efuse__server__apis.html#ga475005d64d5d8d97dae539743f7793b9">XNvm_EfuseWriteAesKey()</a>.</p>

</div>
</div>
<a class="anchor" id="ga2aca2c53d5bb8c2d003e5a5e4097b884"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_EfuseValidateDecOnlyRequest </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function validates DEC_ONLY eFuse programming request. </p>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS - if validation is successful.<ul>
<li>XNVM_EFUSE_ERR_INVALID_PARAM - On Invalid Parameter.</li>
</ul>
</dd></dl>
<ul>
<li>XNVM_EFUSE_ERR_DEC_ONLY_KEY_MUST_BE_PRGMD- Aes key should be programmed for DEC_ONLY eFuse programming.</li>
<li>XNVM_EFUSE_ERR_DEC_ONLY_IV_MUST_BE_PRGMD - Blk IV should be programmed for DEC_ONLY eFuse programming.</li>
<li>XNVM_EFUSE_ERR_DEC_ONLY_PUF_HD_MUST_BE_PRGMD - Puf helper should be programmed for DEC_ONLY eFuse programming. </li>
</ul>
<p>Read direct from cache at offset of SECURITY_MISC_0. Return XNVM_EFUSE_ERR_DEC_ONLY_ALREADY_PRGMD if decrypt only not enabled</p>
<p>Check Zeros at offset of all IVs. Return XNVM_EFUSE_ERR_DEC_ONLY_IV_MUST_BE_PRGMD if not success</p>

<p>References <a class="el" href="xnvm__efuseclient__hw_8h.html#a88247ae52e7771b1040b0be80956e1be">XNVM_EFUSE_CACHE_DEC_EFUSE_ONLY_MASK</a>, <a class="el" href="group__xnvm__efuse__server__apis.html#gae90a96afb82790626728eb3e7b0f8c41">XNVM_EFUSE_CRC_AES_ZEROS</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fcafdeb6ff2f4fc25f2645e87cdc8d512d1">XNVM_EFUSE_ERR_DEC_ONLY_ALREADY_PRGMD</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fca3c2a740150b50a17409e36446807a068">XNVM_EFUSE_ERR_DEC_ONLY_KEY_MUST_BE_PRGMD</a>, <a class="el" href="group__xilnvm__versal__net__common__error__codes.html#gga30215236c6d8dc87857fb0cee99c658aa96a99472d9c7ccfc2e3e33cc1097784d">XNVM_EFUSE_ERR_DEC_ONLY_PUF_HD_MUST_BE_PRGMD</a>, <a class="el" href="group__xnvm__util__apis.html#ga43a467daea1ce3c434d0c01e3657c0a9">XNvm_EfuseCheckAesKeyCrc()</a>, <a class="el" href="group__xnvm__versal__net__api__ids.html#ga51762cb7925471e499cb19ff551039d7">XNvm_EfuseIsPufHelperDataEmpty()</a>, and <a class="el" href="group__xnvm__util__apis.html#ga0b8d44122a9957c29ed1be2574a53aed">XNvm_EfuseReadReg()</a>.</p>

<p>Referenced by <a class="el" href="group__xnvm__efuse__server__apis.html#ga37d5999c68b18d7cd4e95bb4fd9105d2">XNvm_EfuseWriteDecOnly()</a>.</p>

</div>
</div>
<a class="anchor" id="ga989884994fda65f39b2f66ced494f83d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_EfuseValidateFipsInfo </td>
          <td>(</td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>FipsMode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>FipsVersion</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is used to validate FIPS mode and FIPS version inputs before programming. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">FipsMode</td><td>- Fips mode to be written to eFuses. </td></tr>
    <tr><td class="paramname">FipsVersion</td><td>- Fips version to be written to eFuses.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS - On successful write. </dd></dl>
<p>Read Fips version direct from cache at offset of CACHE_IP_DISABLE. Return Error code upon failure</p>
<p>Read Fips mode directly from cache at offset of CACHE_DME_FIPS. Return Error code upon failure</p>

<p>References <a class="el" href="xnvm__efuseclient__hw_8h.html#a95479077afc08899f0e3f2fb1174eddf">XNVM_EFUSE_CACHE_DME_FIPS_FIPS_MODE_MASK</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fca91e4b12e40ef1fd3a78d16279d51d2d0">XNVM_EFUSE_ERR_BEFORE_PROGRAMMING</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fcac0545366db336e916c12b41d86ae3c39">XNVM_EFUSE_ERR_BIT_CANT_REVERT</a>, and <a class="el" href="group__xnvm__util__apis.html#ga0b8d44122a9957c29ed1be2574a53aed">XNvm_EfuseReadReg()</a>.</p>

<p>Referenced by <a class="el" href="group__xnvm__efuse__server__apis.html#ga9b518b5753573d6f65ba1d15c94fce86">XNvm_EfuseWriteFipsInfo()</a>.</p>

</div>
</div>
<a class="anchor" id="gabe9934f94cf8712b7b30ad3502eb5565"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_EfuseValidateIvWriteReq </td>
          <td>(</td>
          <td class="paramtype">XNvm_IvType&#160;</td>
          <td class="paramname"><em>IvType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XNvm_Iv *&#160;</td>
          <td class="paramname"><em>EfuseIv</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function validates all IVs requested for programming. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">IvType</td><td>- IvType to be validated </td></tr>
    <tr><td class="paramname">EfuseIv</td><td>- Pointer to XNvm_EfuseIvs structure which holds IV data to be programmed to eFuse.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS - if validation is successful.<ul>
<li>XNVM_EFUSE_ERR_WRITE_META_HEADER_IV_RANGE - Error in Metaheader IV range write request.</li>
<li>XNVM_EFUSE_ERR_BLK_OBFUS_IV_ALREADY_PRGMD - Error in Blk Obfus Iv write request.</li>
<li>XNVM_EFUSE_ERR_WRITE_PLM_IV_RANGE - Error in Plm Iv range write request.</li>
<li>XNVM_EFUSE_ERR_WRITE_DATA_PARTITION_IV_RANGE - Error in Data Partition Iv range write request. </li>
</ul>
</dd></dl>
<p>validate the input parameters. Return XNVM_EFUSE_ERR_INVALID_PARAM if inputs parameters are invalid</p>
<p>Check Zeros at offset of Black_Iv. Return XNVM_EFUSE_ERR_BLK_OBFUS_IV_ALREADY_PRGMD if not success</p>
<p>Validate Ivs. Return Error code upon failure</p>

<p>References <a class="el" href="xnvm__efuseclient__hw_8h.html#a2bed27efcecfc1d0a6cce977bcd8d6a0">XNVM_EFUSE_CACHE_METAHEADER_IV_RANGE_0_OFFSET</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fca7b552bb4aed2e1f3e3dd54f5adeccadf">XNVM_EFUSE_ERR_BLK_OBFUS_IV_ALREADY_PRGMD</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fca9a62e9c5d07c9b4e2dd2c350275e632b">XNVM_EFUSE_ERR_INVALID_PARAM</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fcab47c0ff687faed5330cb07becbabda7b">XNVM_EFUSE_ERR_WRITE_META_HEADER_IV_RANGE</a>, <a class="el" href="group__xnvm__efuse__server__apis.html#gab8f5eff3de624d650309262ed9243b29">XNVM_EFUSE_ERROR_BYTE_SHIFT</a>, and <a class="el" href="group__xnvm__versal__net__api__ids.html#ga074ef023f48a3f5164b0bf0f6d464d5c">XNvm_EfuseCheckZeros()</a>.</p>

<p>Referenced by <a class="el" href="group__xnvm__efuse__server__apis.html#ga99b50ea3f231e5b81fd8d3e944daa3ff">XNvm_EfuseWriteIv()</a>.</p>

</div>
</div>
<a class="anchor" id="gacc264f1596fadaaf19db535bf527435a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_EfuseValidatePpkHashWriteReq </td>
          <td>(</td>
          <td class="paramtype">XNvm_PpkType&#160;</td>
          <td class="paramname"><em>PpkType</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function validates PPK Hash requested for programming. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">PpkType</td><td>- PpkHash0/PpkHash1/PpkHash2 type of PpkHash request to be validated</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS - if validates successfully.<ul>
<li>XNVM_EFUSE_ERR_PPK0_HASH_ALREADY_PRGMD - Ppk0 hash already programmed.</li>
<li>XNVM_EFUSE_ERR_PPK1_HASH_ALREADY_PRGMD - Ppk1 hash already programmed.</li>
<li>XNVM_EFUSE_ERR_PPK2_HASH_ALREADY_PRGMD - Ppk2 hash already programmed.</li>
<li>XNVM_EFUSE_ERR_FUSE_PROTECTED - eFuse is write protected.</li>
<li>XNVM_EFUSE_ERR_WRITE_PPK0_HASH - Error in writing ppk0 hash.</li>
<li>XNVM_EFUSE_ERR_WRITE_PPK1_HASH - Error in writing ppk1 hash.</li>
<li>XNVM_EFUSE_ERR_WRITE_PPK2_HASH - Error in writing ppk2 hash. </li>
</ul>
</dd></dl>
<p>Read the security control bits at offset of SECURITY_CTRL</p>
<p>Check for zeros in eFuse. Return XNVM_EFUSE_ERR_PPK0_HASH_ALREADY_PRGMD if not success</p>

<p>References <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fcad266d3a6d6afe7285781c476aa586575">XNVM_EFUSE_ERR_FUSE_PROTECTED</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fca9a62e9c5d07c9b4e2dd2c350275e632b">XNVM_EFUSE_ERR_INVALID_PARAM</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fca97176d037b4c9b5282639b5702c187b4">XNVM_EFUSE_ERR_PPK0_HASH_ALREADY_PRGMD</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fca213e9cea5131d2070dc3f83ed73251e4">XNVM_EFUSE_ERR_WRITE_PPK0_HASH</a>, <a class="el" href="group__xnvm__efuse__server__apis.html#gab8f5eff3de624d650309262ed9243b29">XNVM_EFUSE_ERROR_BYTE_SHIFT</a>, <a class="el" href="group__xnvm__efuse__server__apis.html#gaba51a149137ee78fa0d298a6c79b80a1">XNVM_EFUSE_ERROR_NIBBLE_SHIFT</a>, <a class="el" href="group__xnvm__versal__net__api__ids.html#ga074ef023f48a3f5164b0bf0f6d464d5c">XNvm_EfuseCheckZeros()</a>, and <a class="el" href="group__xnvm__util__apis.html#ga0b8d44122a9957c29ed1be2574a53aed">XNvm_EfuseReadReg()</a>.</p>

<p>Referenced by <a class="el" href="group__xnvm__efuse__server__apis.html#ga5093d8298f30653879f3f0f3023029bd">XNvm_EfuseWritePpkHash()</a>.</p>

</div>
</div>
<a class="anchor" id="ga05cd2825902d18394a7ba8c56c5342b6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XNvm_IsDmeModeEn </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function checks DME Mode is enabled or disabled. </p>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS - if DME Mode is not set.<ul>
<li>XNVM_EFUSE_ERROR_DME_MODE_SET | XNVM_EFUSE_ERR_BEFORE_PROGRAMMING<ul>
<li>if DME Mdoe is set. </li>
</ul>
</li>
</ul>
</dd></dl>
<p>Read DME Mode from DME FIPS register and return error if DME Mode is set</p>

<p>References <a class="el" href="xnvm__validate_8c.html#a2950926fc79b839724b72384f9b04cf9">XNVM_EFUSE_CACHE_DME_FIPS_DME_MODE_MASK</a>, <a class="el" href="group__xilnvm__error__codes.html#gga00c7dbe244969a974957cec19d29f1fca91e4b12e40ef1fd3a78d16279d51d2d0">XNVM_EFUSE_ERR_BEFORE_PROGRAMMING</a>, <a class="el" href="group__xilnvm__versal__net__common__error__codes.html#gga30215236c6d8dc87857fb0cee99c658aa8d569b038be8de9b2f0ec20a11f438e8">XNVM_EFUSE_ERROR_DME_MODE_SET</a>, and <a class="el" href="group__xnvm__util__apis.html#ga0b8d44122a9957c29ed1be2574a53aed">XNvm_EfuseReadReg()</a>.</p>

<p>Referenced by <a class="el" href="group__xnvm__efuse__client__apis.html#gad7ec755ce9206a3cdb6263b452c71c29">XNvm_EfuseReadUserFuses()</a>, and <a class="el" href="group__xnvm__efuse__server__apis.html#ga6c6a62d77c7a495ffaf45390f771dc65">XNvm_EfuseWriteDmeUserKey()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
